// --------------------------------------------------------------------------------------------------------------------
// <copyright file="InterpolationMessage.cs" company="Microsoft Corporation">
// The MIT License (MIT)
// 
// Copyright (c) 2014, Microsoft Corporation
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
//  of this software and associated documentation files (the "Software"), to deal
//  in the Software without restriction, including without limitation the rights
//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
//  copies of the Software, and to permit persons to whom the Software is
//  furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
//  all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
//  THE SOFTWARE.
// </copyright>
// --------------------------------------------------------------------------------------------------------------------
namespace Microsoft.Robotics.Runtime
{
    using System.Runtime.Serialization;

    /// <summary>
    /// Represents a interpolation message, which consists of start value, end value and the interpolation time.
    /// </summary>
    /// <typeparam name="TInput">The type of message to interpolate.</typeparam>
    [DataContract]
    public class InterpolationMessage<TInput> : AgentMessage
        where TInput : AgentMessage
    {
        /// <summary>
        /// The start message for interpolation.
        /// </summary>
        [DataMember]
        private TInput startValue;

        /// <summary>
        /// The end message in the interpolation.
        /// </summary>
        [DataMember]
        private TInput endValue;

        /// <summary>
        /// The interpolation time.
        /// </summary>
        [DataMember]
        private long interpolationTime;

        /// <summary>
        /// Initializes a new instance of the InterpolationMessage class.
        /// </summary>
        /// <param name="startValue">The start message for interpolation.</param>
        /// <param name="endValue">The end message in the interpolation.</param>
        /// <param name="interpolationTime">Interpolation time</param>
        public InterpolationMessage(TInput startValue, TInput endValue, long interpolationTime)
            : base(interpolationTime)
        {
            this.startValue = startValue;
            this.endValue = endValue;
            this.interpolationTime = interpolationTime;
        }

        /// <summary>
        /// Gets the start message for interpolation.
        /// </summary>
        public TInput StartValue
        {
            get { return this.startValue; }
        }

        /// <summary>
        /// Gets the end message for interpolation.
        /// </summary>
        public TInput EndValue
        {
            get { return this.endValue; }
        }

        /// <summary>
        /// Gets the interpolation time.
        /// </summary>
        public long InterpolationTime
        {
            get { return this.interpolationTime; }
        }
    }
}
